/**
 * Software License, Version 1.0
 * 
 * Copyright 2003 The Trustees of Indiana University.  All rights reserved.
 * 
 *
 *Redistribution and use in source and binary forms, with or without 
 *modification, are permitted provided that the following conditions are met:
 *
 *1) All redistributions of source code must retain the above copyright notice,
 * the list of authors in the original source code, this list of conditions and
 * the disclaimer listed in this license;
 *2) All redistributions in binary form must reproduce the above copyright 
 * notice, this list of conditions and the disclaimer listed in this license in
 * the documentation and/or other materials provided with the distribution;
 *3) Any documentation included with all redistributions must include the 
 * following acknowledgement:
 *
 *"This product includes software developed by the Community Grids Lab. For 
 * further information contact the Community Grids Lab at 
 * http://communitygrids.iu.edu/."
 *
 * Alternatively, this acknowledgement may appear in the software itself, and 
 * wherever such third-party acknowledgments normally appear.
 * 
 *4) The name Indiana University or Community Grids Lab or NaradaBrokering, 
 * shall not be used to endorse or promote products derived from this software 
 * without prior written permission from Indiana University.  For written 
 * permission, please contact the Advanced Research and Technology Institute 
 * ("ARTI") at 351 West 10th Street, Indianapolis, Indiana 46202.
 *5) Products derived from this software may not be called NaradaBrokering, 
 * nor may Indiana University or Community Grids Lab or NaradaBrokering appear
 * in their name, without prior written permission of ARTI.
 * 
 *
 * Indiana University provides no reassurances that the source code provided 
 * does not infringe the patent or any other intellectual property rights of 
 * any other entity.  Indiana University disclaims any liability to any 
 * recipient for claims brought by any other entity based on infringement of 
 * intellectual property rights or otherwise.  
 *
 *LICENSEE UNDERSTANDS THAT SOFTWARE IS PROVIDED "AS IS" FOR WHICH NO 
 *WARRANTIES AS TO CAPABILITIES OR ACCURACY ARE MADE. INDIANA UNIVERSITY GIVES
 *NO WARRANTIES AND MAKES NO REPRESENTATION THAT SOFTWARE IS FREE OF 
 *INFRINGEMENT OF THIRD PARTY PATENT, COPYRIGHT, OR OTHER PROPRIETARY RIGHTS. 
 *INDIANA UNIVERSITY MAKES NO WARRANTIES THAT SOFTWARE IS FREE FROM "BUGS", 
 *"VIRUSES", "TROJAN HORSES", "TRAP DOORS", "WORMS", OR OTHER HARMFUL CODE.  
 *LICENSEE ASSUMES THE ENTIRE RISK AS TO THE PERFORMANCE OF SOFTWARE AND/OR 
 *ASSOCIATED MATERIALS, AND TO THE PERFORMANCE AND VALIDITY OF INFORMATION 
 *GENERATED USING SOFTWARE.
 */
package cgl.narada.service.qos;

import java.util.Properties;

import cgl.narada.event.NBEvent;
import cgl.narada.event.impl.NBEventGenerator;
import cgl.narada.matching.Profile;
import cgl.narada.service.Service;
import cgl.narada.service.ServiceException;
import cgl.narada.service.client.EventConsumer;
import cgl.narada.service.client.EventProducer;
import cgl.narada.service.reliable.events.RdArchivalServiceNotification;
import cgl.narada.service.tds.TDService;

/** This class provides a set of core functions that service implementations
    need to satisfy. All services within the system need to conform to this
    interface. 

    @author Shrideep Pallickara
    $Date$
    $Revision$
*/

public interface QosService extends Service {
  
  /** Retrieve the TDS service. */
  public TDService getTDService();
	
  /** Restart Buffering and TDS services. */
  public void restartRtspServices();

  
  public void connectionInitialized();
  
  /** Initializes broker communications based on the properties specified */
  public void initializeBrokerCommunications(int entityId, Properties props,
					     String commType) 
    throws ServiceException;

  /** Retrieves the entityId of the managed entity */
  public int getEntityId();

  
  public NBEventGenerator getEventGenerator();
  
  /** Processes a received event */
  public void processReceivedEvent(NBEvent nbEvent);


  /** Called upon the reliable delivery of an event */
  public void 
  onReliableDelivery(QosEvent qosEvent, 
		     RdArchivalServiceNotification archNotification);
  
  /** Called upon the advance of the syncpoint associated with an entity */
  public void 
  onAdvanceOfSyncpoint(int entityId, int templateId, long advanceSync);


  /** Call upon the ordered delivery of an event */
  public void onOrderedDelivery(QosEvent qosEvent);

  /** Generates a unique consumer id */
  public int generateConsumerId();

   /** Generates a unique producer id */
  public int generateProducerId();

  /** This method registers a consumer with the Qos manager */
  public void registerConsumer(int consumerId, EventConsumer consumer);

  /** Deregister a consumer */
  public void deregisterConsumer(int consumerId);
  
  /** This method is used to register producers with the QoS Manager. */
  public void registerProducer(int producerId, EventProducer producer);

  /** This method is used to register producers with the QoS Manager. */
  public void deregisterProducer(int producerId);
  
  /** Publish an event for a producer based on the specified constraints */
  public void publishEvent(NBEvent nbEvent, 
			   ProducerConstraints producerConstraints,
			   int producerId) 
    throws ServiceException;

  
  /** Subscribe to a profile based on the specified consumer constraints */
  public void 
  subscribeTo(Profile profile, ConsumerConstraints consumerConstraints,
	      int consumerId) 
    throws ServiceException;

  /** Unsubscribe from a profile */
  public void unsubscribe(Profile profile) throws ServiceException;

  /** Recover */
  public long recoverEntity(int conducerId, int entityId, int templateId, 
			    boolean isPublisher);

  public void closeBrokerConnection() throws ServiceException;

   /** Terminate services that are currently running within the JVM */
  public void terminateServices() throws ServiceException;
}
